# Q. What is this file?
# A. This file contains options which allow you to configure your multiworld experience while allowing
#    others to play how they want as well.
#
# Q. How do I use it?
# A. The options in this file are weighted. This means the higher number you assign to a value, the
#    more chances you have for that option to be chosen. For example, an option like this:
#
#    map_shuffle:
#      on: 5
#      off: 15
#
#    Means you have 5 chances for map shuffle to occur, and 15 chances for map shuffle to be turned
#    off.
#
# Q. I've never seen a file like this before. What characters am I allowed to use?
# A. This is a .yaml file. You are allowed to use most characters.
#    To test if your yaml is valid or not, you can use this website:
#        http://www.yamllint.com/
#    You can also verify that your Archipelago options are valid at this site:
#        https://archipelago.gg/check

# Your name in-game, limited to 16 characters.
#     {player} will be replaced with the player's slot number.
#     {PLAYER} will be replaced with the player's slot number, if that slot number is greater than 1.
#     {number} will be replaced with the counter value of the name.
#     {NUMBER} will be replaced with the counter value of the name, if the counter value is greater than 1.
name: Player{number}

# Used to describe your yaml. Useful if you have multiple files.
description: Default Uncanny Cat Golf Template

game: Uncanny Cat Golf
requires:
  version: 0.6.7 # Version of Archipelago required for this yaml to work as expected.
  game:
    Uncanny Cat Golf: 1.0.3 # Version of the world required for this yaml to work as expected.

Uncanny Cat Golf:
  ################
  # Game Options #
  ################
  progression_balancing:
    # A system that can move progression earlier, to try and prevent the player from getting stuck and bored early.
    # 
    # A lower setting means more getting stuck. A higher setting means less getting stuck.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 99
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-99: 0 # random value between 0 and 99
    disabled: 0 # equivalent to 0
    normal: 50 # equivalent to 50
    extreme: 0 # equivalent to 99

  accessibility:
    # Set rules for reachability of your items/locations.
    # 
    # **Full:** ensure everything can be reached and acquired.
    # 
    # **Minimal:** ensure what is needed to reach your goal can be acquired.
    full: 50
    minimal: 0

  goal_level:
    # Set what goal level you want to do have as your final level.
    # This level is removed from the multiworld, if selected, and will not be an item sent.
    # Levels from World 5 or World P will force enable those worlds if selected, and the worlds aren't enabled
    '3_18': 0
    '4_17': 50
    '5_18': 0
    p_17: 0

  prism_unlock_amount:
    # How many prisms are required to be obtained in total before your goal level unlocks.
    # Requirement may be forcefully lowered to account for disabled levels or peak checks being disabled.
    # You can always view the required amount you need in game to reference it.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 50
    # Maximum value is 560
    200: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-50-560: 0 # random value between 50 and 560

  gimmick_lock:
    # Lock level gimmicks such as wormholes, dogs, toggle switches, etc. behind items in the multiworld.
    'false': 0
    'true': 50

  level_unlock_style:
    # How level unlocks are handled.
    # 
    # Individual: All level unlocks are individual items you must be sent
    # World: Worlds are unlocks that you must be sent, you get access to all levels after being sent that world
    individual: 50
    world: 0

  minigames:
    # Enable minigames as checks, such as Bort Bash, UNCANNY_DASH, Meowls, etc.
    'false': 50
    'true': 0

  world_5_levels:
    # Include World 5 (Elysian Fields) levels as checks.
    'false': 50
    'true': 0

  world_p_levels:
    # Include World P (Cosmic Championship) levels as checks. These are a big step up in difficulty, so be warned
    'false': 50
    'true': 0

  world_e_levels:
    # Include World E levels as checks, which are exclusive levels from the Endless Shuffle.
    'false': 50
    'true': 0

  peak_checks:
    # Add a check for gaining a "PEAK" rank in a level. These can be really difficult.
    'false': 50
    'true': 0

  rank_check_difficulty:
    # Which in-game rank sends the per-level rank check.
    # 
    # OK: An "OK" (3 prism) rank or better sends the check.
    # Good: A "GOOD" (4 prism) rank or better is required.
    # 
    # Every level always has a rank check. This only sets how hard it is to send one.
    # This also determines how many levels are required to goal your game for logic.
    ok: 0
    good: 50

  temp_modifiers:
    # Adds temporary modifier items based on the existing modifiers, some of which are traps and some are useful. These last until you complete a level.
    # If you find these too difficult, you can always go back to 0-1 to cycle through them, as that level will always be available.
    # 
    # When enabled, these make up all of the filler in your pool. When disabled, that filler is all Uncanny Cat Spray instead.
    # Either way you still get one of each of the costumes and other one-off filler items.
    'false': 0
    'true': 50

  chill_mode:
    # Enable the "Chill Mode" modifier that removes the Uncanny Cat entirely. This makes the game significantly easier.
    # This can be disabled/enabled in the mod config.
    'false': 50
    'true': 0

  panic_mode:
    # Enable the "Panic Mode" modifier that speeds up the Uncanny Cat quite a bit. This makes the game significantly harder, and may
    # result in unbeatable seeds depending on your skill levels. BE WARNED.
    # 
    # DO NOT ENABLE THIS IF YOU AREN'T PREPARED FOR WHAT IT ENTAILS.
    # 
    # Automatically disabled if "Chill Mode" is enabled.
    # This can be disabled/enabled in the mod config.
    'false': 50
    'true': 0

  death_link:
    # When you die, everyone who enabled death link dies. Of course, the reverse is true too.
    'false': 50
    'true': 0

  death_link_amnesty:
    # Amount of deaths before sending a Death Link.
    # This can be changed in the mod config.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 10
    5: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-10: 0 # random value between 1 and 10

  ###########################
  # Item & Location Options #
  ###########################
  local_items:
    # Forces these items to be in their native world.
    []

  non_local_items:
    # Forces these items to be outside their native world.
    []

  start_inventory:
    # Start with the specified amount of these items. Example: "Bomb: 1"
    {}

  start_hints:
    # Start with these item's locations prefilled into the ``!hint`` command.
    []

  start_location_hints:
    # Start with these locations and their item prefilled into the ``!hint`` command.
    []

  exclude_locations:
    # Prevent these locations from having an important item.
    []

  priority_locations:
    # Prevent these locations from having an unimportant item.
    []

  item_links:
    # Share part of your item pool with other players.
    []

  plando_items:
    # Generic items plando.
    []
